<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template d_ary_heap</title>
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../heap/reference.html#doxygen.d__ary__heap_8hpp" title="Header &lt;boost/heap/d_ary_heap.hpp&gt;">
<link rel="prev" href="classboost_1_1heap_1_1binomial__heap.html" title="Class template binomial_heap">
<link rel="next" href="classboost_1_1heap_1_1fibonacci__heap.html" title="Class template fibonacci_heap">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.html">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1heap_1_1binomial__heap.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap/reference.html#doxygen.d__ary__heap_8hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1heap_1_1fibonacci__heap.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="doxygen.classboost_1_1heap_1_1d__ary__heap"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template d_ary_heap</span></h2>
<p>boost::heap::d_ary_heap — d-ary heap class </p>
</div>
<h2 class="refsynopsisdiv-title">Synopsis</h2>
<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../heap/reference.html#doxygen.d__ary__heap_8hpp" title="Header &lt;boost/heap/d_ary_heap.hpp&gt;">boost/heap/d_ary_heap.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Options<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heaptypes">types</a></span>
  <span class="keyword">typedef</span> <span class="identifier">T</span>                                        <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1abdc4bb72e52098210dffeb4b66edd2f9"></a><span class="identifier">value_type</span><span class="special">;</span>      
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">size_type</span>        <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ac1d64195ebec81be854888cfb3c0af73"></a><span class="identifier">size_type</span><span class="special">;</span>       
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">difference_type</span>  <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a60cf7bb40f0eaf031e22974f4ed35d4b"></a><span class="identifier">difference_type</span><span class="special">;</span> 
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">value_compare</span>    <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ace6e87ba37e9302a445b8b8975a3e44b"></a><span class="identifier">value_compare</span><span class="special">;</span>   
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">allocator_type</span>   <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a90742cee93375918dc7dc955d23e9240"></a><span class="identifier">allocator_type</span><span class="special">;</span>  
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">reference</span>        <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a90ef1dfd8c9930f05370725c4170bab1"></a><span class="identifier">reference</span><span class="special">;</span>       
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_reference</span>  <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a0e3706caa389dbd4983174dc5781d96a"></a><span class="identifier">const_reference</span><span class="special">;</span> 
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">pointer</span>          <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a99b55b7045ff3024145e71224ef4e717"></a><span class="identifier">pointer</span><span class="special">;</span>         
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_pointer</span>    <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a472c36ca63e05bf749492f37c8130294"></a><span class="identifier">const_pointer</span><span class="special">;</span>   
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span>         <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1ad19e4fbf3337cac7f4652daf7347ba40"><span class="identifier">iterator</span></a><span class="special">;</span>        
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_iterator</span>   <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1af7fbde9b5db367d19452ae0fe90a0d9c"></a><span class="identifier">const_iterator</span><span class="special">;</span>  
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">ordered_iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a6ad30cd30a93f56f72b9314e893eecd8"></a><span class="identifier">ordered_iterator</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">handle_type</span>      <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ad43933aeaad61c8e0baeb73481d4f46a"></a><span class="identifier">handle_type</span><span class="special">;</span>     

  <span class="comment">// <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#id-1_3_15_6_2_1_1_1_22-bb">public member functions</a></span>
  <span class="keyword">explicit</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1adba764f939634f5e6b73b76bb221d8c8"><span class="identifier">d_ary_heap</span></a><span class="special">(</span><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">value_compare</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1ad19bebafcb2ba21c6f953a91fc509e2a"><span class="identifier">d_ary_heap</span></a><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a9a9e1e903f29ab2102bb711a49229497"><span class="identifier">d_ary_heap</span></a><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1acd4eff880258813665643bf4ea9169f9"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a0cad73a5f4c2259e3906ee4c63514847"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a5ecfe8563e4db23e8cb9bd717f99bb62"><span class="identifier">empty</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">size_type</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a5cb9690ef67b6d87395956256b43a2d9"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">size_type</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a606b3e49c8f9bb59f94769d410b1340f"><span class="identifier">max_size</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a81b258099544ac324437ca882ae88a84"><span class="identifier">clear</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">allocator_type</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a95e8358334ce9e31dcb5123b050e664d"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a0410e641d357ffd3d4bdaec07618c999"><span class="identifier">top</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">conditional</span><span class="special">&lt;</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
  <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a9c3ee8282045fd8170594a99c0ae1760"><span class="identifier">push</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span> 
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">conditional</span><span class="special">&lt;</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
    <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1ab6dd60787bb57667ac3bec41244c4587"><span class="identifier">emplace</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a74521828957ad9aeab69ec5d0ccfc125"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a615141efc0cd59a18143ddfa25361ceb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1aafede81298985cc4b608680463f1918a"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a73c040da45f2bce1b69e1250b404ebb7"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a6b85fd3bfd4e6d072cf189f3b88b6f6e"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1ae35002bcc49ea41f60d862465cb5ea20"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a5a40acdd88b4e0d4a2844eb2036e7652"><span class="identifier">update</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a0844e5f0a021d2dc274efc4f75f18e83"><span class="identifier">update</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a28deeccf26e81dcd6cbe84c04e6592e9"><span class="identifier">increase</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a47b8c52d86aa4d4b5a1205ce9377f24b"><span class="identifier">increase</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a26f5e87cee72497faee3b41998d28843"><span class="identifier">decrease</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a9f481afa0044823d428f3596027fbdc0"><span class="identifier">decrease</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a5d1b9fa9f2fb6c79b66c655427108347"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a5afcde76809638f928af3837a0573a8a"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a13a3239b65057604ace276848ecc0f65"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">const_iterator</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a79515a98d2a28784bdeab74b77cd2e7b"><span class="identifier">begin</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1abb7de9c3c96705901f0bb2d78ad944e3"><span class="identifier">begin</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a8b85d2d0ecb2637b12e7997a7d18ecc7"><span class="identifier">end</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">const_iterator</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1ab913ab7aff6cea68331ca535f72a2bf2"><span class="identifier">end</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">ordered_iterator</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a29940c60e961250c3406bc878f226c85"><span class="identifier">ordered_begin</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">ordered_iterator</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1ad8b99531e83c146743f01b7dcead12b4"><span class="identifier">ordered_end</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a56f85b2c854c292646e075d47bd21949"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1af44a5b27b7de1169cde0f208f6f796f2"><span class="identifier">value_comp</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#id-1_3_15_6_2_1_1_1_23-bb">public static functions</a></span>
  <span class="keyword">static</span> <span class="identifier">handle_type</span> <a class="link" href="classboost_1_1heap_1_1d__ary__heap.html#doxygen.classboost_1_1heap_1_1d__ary__heap_1a6f8c114dba213a386c3454a6d2e91a06"><span class="identifier">s_handle_from_iterator</span></a><span class="special">(</span><span class="identifier">iterator</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// public data members</span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">constant_time_size</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">has_ordered_iterators</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">is_mergable</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">has_reserve</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">is_stable</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.15.6.3.3.4"></a><h2>Description</h2>
<p>This class implements an immutable priority queue. Internally, the d-ary heap is represented as dynamically sized array (std::vector), that directly stores the values.</p>
<p>The template parameter T is the type to be managed by the container. The user can specify additional options and if no options are provided default options are used.</p>
<p>The container supports the following options:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><code class="computeroutput">boost::heap::arity&lt;&gt;</code>, required</p></li>
<li class="listitem"><p><code class="computeroutput">boost::heap::compare&lt;&gt;</code>, defaults to <code class="computeroutput">compare&lt;std::less&lt;T&gt;</code> &gt;</p></li>
<li class="listitem"><p><code class="computeroutput">boost::heap::stable&lt;&gt;</code>, defaults to <code class="computeroutput">stable&lt;false&gt;</code> </p></li>
<li class="listitem"><p><code class="computeroutput">boost::heap::stability_counter_type&lt;&gt;</code>, defaults to <code class="computeroutput">stability_counter_type&lt;boost::uintmax_t&gt;</code> </p></li>
<li class="listitem"><p><code class="computeroutput">boost::heap::allocator&lt;&gt;</code>, defaults to <code class="computeroutput">allocator&lt;std::allocator&lt;T&gt;</code> &gt;</p></li>
<li class="listitem"><p><code class="computeroutput">boost::heap::mutable_&lt;&gt;</code>, defaults to <code class="computeroutput">mutable_&lt;false&gt;</code> </p></li>
</ul></div>
<p>
</p>
<div class="refsect2">
<a name="id-1.3.15.6.3.3.4.5"></a><h3>
<a name="doxygen.classboost_1_1heap_1_1d__ary__heaptypes"></a><code class="computeroutput">d_ary_heap</code> 
        public
       types</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<p>
<span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ad19e4fbf3337cac7f4652daf7347ba40"></a><span class="identifier">iterator</span><span class="special">;</span></p>
<p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities.    </p>
</li></ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.15.6.3.3.4.6"></a><h3>
<a name="id-1_3_15_6_2_1_1_1_22-bb"></a><code class="computeroutput">d_ary_heap</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1adba764f939634f5e6b73b76bb221d8c8"></a><span class="identifier">d_ary_heap</span><span class="special">(</span><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> cmp <span class="special">=</span> <span class="identifier">value_compare</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ad19bebafcb2ba21c6f953a91fc509e2a"></a><span class="identifier">d_ary_heap</span><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Linear.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a9a9e1e903f29ab2102bb711a49229497"></a><span class="identifier">d_ary_heap</span><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1acd4eff880258813665643bf4ea9169f9"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a0cad73a5f4c2259e3906ee4c63514847"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Linear.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a5ecfe8563e4db23e8cb9bd717f99bb62"></a><span class="identifier">empty</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">size_type</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a5cb9690ef67b6d87395956256b43a2d9"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">size_type</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a606b3e49c8f9bb59f94769d410b1340f"></a><span class="identifier">max_size</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a81b258099544ac324437ca882ae88a84"></a><span class="identifier">clear</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Linear.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a95e8358334ce9e31dcb5123b050e664d"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a0410e641d357ffd3d4bdaec07618c999"></a><span class="identifier">top</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns a const_reference to the maximum element.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">conditional</span><span class="special">&lt;</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
<a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a9c3ee8282045fd8170594a99c0ae1760"></a><span class="identifier">push</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> v<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case).    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span> 
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">conditional</span><span class="special">&lt;</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
  <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ab6dd60787bb57667ac3bec41244c4587"></a><span class="identifier">emplace</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. The element is directly constructed in-place.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case).    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a74521828957ad9aeab69ec5d0ccfc125"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a615141efc0cd59a18143ddfa25361ceb"></a><span class="keyword">operator</span><span class="special">&gt;</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1aafede81298985cc4b608680463f1918a"></a><span class="keyword">operator</span><span class="special">&gt;=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a73c040da45f2bce1b69e1250b404ebb7"></a><span class="keyword">operator</span><span class="special">&lt;=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a6b85fd3bfd4e6d072cf189f3b88b6f6e"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equivalent comparison <span class="bold"><strong>Returns:</strong></span> True, if both heap data structures are equivalent.    <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ae35002bcc49ea41f60d862465cb5ea20"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equivalent comparison <span class="bold"><strong>Returns:</strong></span> True, if both heap data structures are not equivalent.    <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a5a40acdd88b4e0d4a2844eb2036e7652"></a><span class="identifier">update</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> &amp; updates the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a0844e5f0a021d2dc274efc4f75f18e83"></a><span class="identifier">update</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Note:</strong></span> If this is not called, after a handle has been updated, the behavior of the data structure is undefined!</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a28deeccf26e81dcd6cbe84c04e6592e9"></a><span class="identifier">increase</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> &amp; updates the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be greater than the current one</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a47b8c52d86aa4d4b5a1205ce9377f24b"></a><span class="identifier">increase</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be greater than the current one. If this is not called, after a handle has been updated, the behavior of the data structure is undefined!</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a26f5e87cee72497faee3b41998d28843"></a><span class="identifier">decrease</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> &amp; updates the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be less than the current one</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a9f481afa0044823d428f3596027fbdc0"></a><span class="identifier">decrease</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be less than the current one. If this is not called, after a handle has been updated, the behavior of the data structure is undefined!</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a5d1b9fa9f2fb6c79b66c655427108347"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Removes the element handled by <code class="computeroutput">handle</code> from the <a class="link" href="classboost_1_1heap_1_1priority__queue.html" title="Class template priority_queue">priority_queue</a>.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a5afcde76809638f928af3837a0573a8a"></a><span class="identifier">pop</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case).    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a13a3239b65057604ace276848ecc0f65"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="classboost_1_1heap_1_1d__ary__heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a79515a98d2a28784bdeab74b77cd2e7b"></a><span class="identifier">begin</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1abb7de9c3c96705901f0bb2d78ad944e3"></a><span class="identifier">begin</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a8b85d2d0ecb2637b12e7997a7d18ecc7"></a><span class="identifier">end</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ab913ab7aff6cea68331ca535f72a2bf2"></a><span class="identifier">end</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a29940c60e961250c3406bc878f226c85"></a><span class="identifier">ordered_begin</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the first element contained in the priority queue.</p>
<p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1ad8b99531e83c146743f01b7dcead12b4"></a><span class="identifier">ordered_end</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the end of the priority queue.</p>
<p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order.    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a56f85b2c854c292646e075d47bd21949"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> element_count<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Reserves memory for element_count elements</p>
<p><span class="bold"><strong>Complexity:</strong></span> Linear.</p>
<p><span class="bold"><strong>Node:</strong></span> Invalidates iterators    </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1af44a5b27b7de1169cde0f208f6f796f2"></a><span class="identifier">value_comp</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue    </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.15.6.3.3.4.7"></a><h3>
<a name="id-1_3_15_6_2_1_1_1_23-bb"></a><code class="computeroutput">d_ary_heap</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">handle_type</span> <a name="doxygen.classboost_1_1heap_1_1d__ary__heap_1a6f8c114dba213a386c3454a6d2e91a06"></a><span class="identifier">s_handle_from_iterator</span><span class="special">(</span><span class="identifier">iterator</span> <span class="keyword">const</span> <span class="special">&amp;</span> it<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects:</strong></span> Casts an iterator to a node handle.</p>
<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p>
<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p>
</li></ol></div>
</div>
</div>
</div>
<div class="copyright-footer">Copyright © 2010, 2011 Tim Blechmann<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1heap_1_1binomial__heap.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap/reference.html#doxygen.d__ary__heap_8hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1heap_1_1fibonacci__heap.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
